Favicon

You are here: Home > API Reference > Apple > Apple Dep Profiles > Get admDepProfile by Id

Get admDepProfile by Id

Required Permission: mdm.apple.depProfile.get

Get admDepProfile by Id

GET
https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/dep/profiles/{admDepProfileId} 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/dep/profiles/{admDepProfileId}" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/dep/profiles/{admDepProfileId}", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();
import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/dep/profiles/{admDepProfileId}",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
admDepProfileId string
required
Match pattern: ^[a-fA-F0-9]{24}$

Responses

200 Response application/json
status boolean optional
data object optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
organization string optional
Match pattern: ^[a-fA-F0-9]{24}$
admEnterprise string optional
Match pattern: ^[a-fA-F0-9]{24}$
isTemplate boolean optional
profileConfig object optional
profileName string optional
≤ 256 characters
profileUuid string optional
≤ 256 characters
url string optional
≤ 256 characters
allowPairing boolean optional
anchorCerts array [string] optional
autoAdvanceSetup boolean optional
awaitDeviceConfigured boolean optional
configurationWebUrl string optional
≤ 256 characters
department string optional
≤ 256 characters
devices array [string] optional
isMandatory boolean optional
isMdmRemovable boolean optional
isMultiUser boolean optional
isSupervised boolean optional
language string optional
≤ 256 characters
orgMagic string optional
≤ 256 characters
region string optional
≤ 256 characters
skipSetupItems array [string] optional
supervisingHostCerts array [string] optional
supportEmailAddress string optional
≤ 256 characters
supportPhoneNumber string optional
≤ 256 characters
config object optional
profileName string optional
≤ 256 characters
profileUuid string optional
≤ 256 characters
url string optional
≤ 256 characters
allowPairing boolean optional
anchorCerts array [string] optional
autoAdvanceSetup boolean optional
awaitDeviceConfigured boolean optional
configurationWebUrl string optional
≤ 256 characters
department string optional
≤ 256 characters
devices array [string] optional
isMandatory boolean optional
isMdmRemovable boolean optional
isMultiUser boolean optional
isSupervised boolean optional
language string optional
≤ 256 characters
orgMagic string optional
≤ 256 characters
region string optional
≤ 256 characters
skipSetupItems array [string] optional
supervisingHostCerts array [string] optional
supportEmailAddress string optional
≤ 256 characters
supportPhoneNumber string optional
≤ 256 characters
version integer optional
≥ 0
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
{
    "status": true,
    "data": {
        "id": "string",
        "organization": "string",
        "admEnterprise": "string",
        "isTemplate": true,
        "profileConfig": {
            "profileName": "string",
            "profileUuid": "string",
            "url": "string",
            "allowPairing": true,
            "anchorCerts": [
                "string"
            ],
            "autoAdvanceSetup": true,
            "awaitDeviceConfigured": true,
            "configurationWebUrl": "string",
            "department": "string",
            "devices": [
                "string"
            ],
            "isMandatory": true,
            "isMdmRemovable": true,
            "isMultiUser": true,
            "isSupervised": true,
            "language": "string",
            "orgMagic": "string",
            "region": "string",
            "skipSetupItems": [
                "string"
            ],
            "supervisingHostCerts": [
                "string"
            ],
            "supportEmailAddress": "string",
            "supportPhoneNumber": "string"
        },
        "config": {
            "profileName": "string",
            "profileUuid": "string",
            "url": "string",
            "allowPairing": true,
            "anchorCerts": [
                "string"
            ],
            "autoAdvanceSetup": true,
            "awaitDeviceConfigured": true,
            "configurationWebUrl": "string",
            "department": "string",
            "devices": [
                "string"
            ],
            "isMandatory": true,
            "isMdmRemovable": true,
            "isMultiUser": true,
            "isSupervised": true,
            "language": "string",
            "orgMagic": "string",
            "region": "string",
            "skipSetupItems": [
                "string"
            ],
            "supervisingHostCerts": [
                "string"
            ],
            "supportEmailAddress": "string",
            "supportPhoneNumber": "string"
        },
        "version": 0,
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}